AuthManager.idl

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * Copyright 2010 Raritan Inc. All rights reserved.
 */
 
/** Local and Remote Authentication Management */
module auth {
 
    /** Authentication type */
    enumeration Type {
        LOCAL,         ///< local authentication
        RADIUS,        ///< authentication via radius server
        KERBEROS,      ///< authentication with kerberos tickets (not implemented)
        TACACS_PLUS,   ///< authentication via TACACS+ (not implemented)
        LDAP,          ///< authentication via LDAP server
        CC,            ///< cc authentication
        OIDC           ///< authentication via OIDC Identity Provider
    };
 
    /**
     * Authentication policy
     *
     * The authentication policy does only partly apply to SNMPv3 as it always uses local authentication.
     * When SNMPv3 is enabled, all local user accounts for which SNMPv3 access is configured will be
     * available via SNMPv3 except the account has admin privilege and disallowLocalAuthAdminRemoteAccess
     * is set to true.
     */
    structure Policy {
        auth.Type type;                       ///< Authentication type
        boolean disallowLocalAuthAdminRemoteAccess; ///< Disallow remote access for locally authenticated administrators
        boolean useLocalIfRemoteFailed;             ///< Fall back to local authentication if remote authentication fails (deprecated; recommended setting: false)
    };
 
    /** Authentication manager interface */
    interface AuthManager {
 
        constant int ERR_UNSUPPORTED_TYPE = 1; ///< Unsupported authentication type
 
        /**
         * Gets a policy.
         *
         * @return a Policy object
         */
        Policy getPolicy();
 
        /**
         * Sets a policy.
         *
         * @return 0 on success
         * @return 1 in case authentication type is not supported
         */
        int setPolicy(in Policy p);
 
    };
 
}